Add(Boolean,Object[],Boolean) メソッド

新しい行をコレクションに追加します。

シンタックス

Visual Basic

'宣言
 
Public Overloads Function Add( _
   ByVal raiseAddEvents As Boolean, _
   ByVal cellValues() As Object, _
   ByVal bypassEditState As Boolean _
) As UltraDataRow

C#

public UltraDataRow Add( 
   bool raiseAddEvents,
   object[] cellValues,
   bool bypassEditState
)

パラメータ

raiseAddEvents

RowAdding イベントと RowAdded イベントを発生させるかどうかを指定します。このパラメーターを受け取らないこのメソッドのオーバー読み込みでは、このパラメーターはデフォルトで False になります。

cellValues

新しい行を初期化するためのセル値を指定します。配列がnullの場合、配列の要素数が列の数より多い場合、または値を対応する列のデータ型に変換できない場合は、例外がスローされます。

bypassEditState

このパラメーターを True として指定した場合、追加される行は Edit および AddNew の状態になります。Edit状態の行は、((IEditableObject)row).CancelEditを呼び出すことでキャンセルできます。エンドユーザーは、Edit状態の行で［Esc］キーを２回押すことによって、行をキャンセルできます (行がUltraGridまたはDataGridに表示されている場合)。Edit状態の行をキャンセルすると、セル値が元の値 (BeginEditが呼び出されたときの値) に戻ります。AddNew状態の行をキャンセルすると、その行はコレクションから削除されます。このパラメーターを受け取らないこのメソッドのオーバー読み込みでは、このパラメーターはデフォルトで True になります。

戻り値の型

コレクションに追加された新しい行を返します。

解説

Add メソッドは、新しい行を作成してコレクションに追加します。raiseAddEvents 引数に True を指定すると、RowAdding イベントと RowAdded イベントが発生します。RowAdding イベントをキャンセルすると、コレクションに新しい行は追加されず、このメソッドはnullを返します。